Determines whether a particular event could invoke a contextual menu.

Boolean IsShowContextualMenuClick (
    const EventRecord *inEvent
);

inEvent

A pointer to the event structure that describes the event to examine.

function result

If true, the contextual menu should be displayed; if false, not.

DISCUSSION

Before calling the IsShowContextualMenuClick function, you should call InitContextualMenus. If no error is returned, you can then call IsShowContextualMenuClick.

Applications should call IsShowContextualMenuClick when they receive non-null events. If IsShowContextualMenuClick returns true, your application should generate its own menu and Apple Event descriptor (AEDesc), and then call ContextualMenuSelect to display and track the contextual menu, and then handle the user’s choice.

If the mouse-down event did not invoke a contextual menu, then the application should check to see if the event occurred in the menu bar (using the FindWindow function) and, if so, call MenuSelect to allow the user to choose a command from the menu bar.

See also “Contextual Menu Gestalt Selector Constants”.

VERSION NOTES

This function is available with Appearance Manager 1.0 and later.

AVAILABILITY

Supported in Carbon. Available in CarbonLib 1.0 and later when ContextualMenu 1.0 or later is installed. Exported by CarbonLib 1.0 and later and by ContextualMenu 1.0 and later.

© 2000 Apple Computer, Inc. — (Last Updated 4/14/2000)